/* Copyright (c) 2010 OFXKit
 *
 * Licensed under the Apache License, Version 2.0 (the "License");
 * you may not use this file except in compliance with the License.
 * You may obtain a copy of the License at
 *
 * http://www.apache.org/licenses/LICENSE-2.0
 *
 * Unless required by applicable law or agreed to in writing, software
 * distributed under the License is distributed on an "AS IS" BASIS,
 * WITHOUT WARRANTIES OR CONDITIONS OF ANY KIND, either express or implied.
 * See the License for the specific language governing permissions and
 * limitations under the License.
 */

#import <Foundation/Foundation.h>

#import "OFXObject.h"
#import "OFXCurrency.h"

@interface OFXSecurity : OFXObject {
  // OFX Mandatory Elements
  NSString* uniqueId;
  NSString* uniqueIdType;
  NSString* financialInstitutionSecurityId;
  NSString* name;
  NSString* tickerSymbol;
  NSString* rating;
  NSNumber*  unitPrice;
  NSDate*    unitPriceValidAsOf;
  OFXCurrency* currency;
  NSString*   memo;
}

/**
 * @property uniqueId
 * @brief Unique identifier for the security. CUSIP for US FIs. A-32
 */
@property(retain) NSString*    uniqueId;

/**
 * @property uniqueIdType
 * @brief Name of standard used to identify the security i.e., “CUSIP” for FIs
 * in the United States, A-10
 */
@property(retain) NSString*    uniqueIdType;

/**
 * @property financialInstitutionSecurityId
 * @brief FI ID number for this security (at most one), A-32
 */
@property(retain) NSString*    financialInstitutionSecurityId;

/**
 * @property name
 * @brief Full name of security, A-120
 */
@property(retain) NSString*    name;

/**
 * @property tickerSymbol
 * @brief Ticker symbol (at most one), A-32
 */
@property(retain) NSString*    tickerSymbol;

/**
 * @property rating
 * @brief Rating, A-10
 */
@property(retain) NSString*    rating;

/**
 * @property unitPrice
 * @brief Current price of security
 */
@property(retain) NSNumber*    unitPrice;

/**
 * @property unitPriceValidAsOf
 * @brief Date as of for the unit price
 */
@property(retain) NSDate*      unitPriceValidAsOf;

/**
 * @property currency
 * @brief Overriding currency aggregate for unit price
 */
@property(retain) OFXCurrency* currency;

/**
 * @property memo
 * @brief Comments for security
 */
@property(retain) NSString*    memo;

@end
